/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.impl.variable;

import com.je.bpm.engine.internal.Internal;

/**
 * Interface describing a container for all available {@link VariableType}s of variables.
 */
@Internal
public interface VariableTypes {

    /**
     * @return the type for the given type name. Returns null if no type was found with the name.
     */
    VariableType getVariableType(String typeName);

    /**
     * @return the variable type to be used to store the given value as a variable.
     * @throws com.je.bpm.engine.ActivitiException When no available type is capable of storing the value.
     */
    VariableType findVariableType(Object value);

    VariableTypes addType(VariableType type);

    /**
     * Add type at the given index. The index is used when finding a type for an object. When different types can store a specific object value, the one with the smallest index will be used.
     */
    VariableTypes addType(VariableType type, int index);

    int getTypeIndex(VariableType type);

    int getTypeIndex(String typeName);

    VariableTypes removeType(VariableType type);
}
